Skip to content

Terminal string styling done right

License

Notifications You must be signed in to change notification settings

chalk/chalk-cli

Repository files navigation

chalk-cli Downloads run on repl.it

Terminal string styling done right

Install

npm install --global chalk-cli

Usage

$ chalk --help

  Usage
    $ chalk <style> ... <string>
    $ echo <string> | chalk <style> ...

  Options
    --template, -t    Style template. The `~` character negates the style.
    --stdin           Read input from stdin rather than from arguments.
    --no-newline, -n  Don't emit a newline (`\n`) after the input.
    --demo            Demo of all Chalk styles.

  Examples
    $ chalk red bold 'Unicorns & Rainbows'
    $ chalk -t '{red.bold Unicorns & Rainbows}'
    $ chalk -t '{red.bold Dungeons and Dragons {~bold.blue (with added fairies)}}'
    $ echo 'Unicorns from stdin' | chalk --stdin red bold

See supported styles.

Template syntax

  • {red.bold unicorn}
  • {red.bold unicorns} are {blue FUN!!!}
  • {red.bold unicorn {blue.underline dancing}}
  • {red red {~red normal}}
  • {red hey\} still red} not red
  • {red hey\\} not red

Related

  • chalk - API for this module

Maintainers